﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>

  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class MemberDocumentation </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class MemberDocumentation ">
    <meta name="generator" content="docfx ">
  
    <link rel="shortcut icon" href="../api/images/favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet"> 
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    <script type="text/javascript" async="" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.7/MathJax.js?config=TeX-MML-AM_CHTML"></script>
  
  
  
  </head>  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>

        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>

              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../api/images/favicon.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>

        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">

        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="SpiceSharp.Documentation.MemberDocumentation">



  <h1 id="SpiceSharp_Documentation_MemberDocumentation" data-uid="SpiceSharp.Documentation.MemberDocumentation" class="text-break">Class MemberDocumentation</h1>
  <div class="markdown level0 summary"><p>Describes documentation about a member.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
    <div class="level1"><span class="xref">MemberDocumentation</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
    </div>
    <div>
      <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="SpiceSharp.html">SpiceSharp</a>.<a class="xref" href="SpiceSharp.Documentation.html">Documentation</a></h6>
  <h6><strong>Assembly</strong>: SpiceSharp.dll</h6>
  <h5 id="SpiceSharp_Documentation_MemberDocumentation_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class MemberDocumentation</code></pre>
  </div>
  <h3 id="constructors">Constructors
</h3>
  <a id="SpiceSharp_Documentation_MemberDocumentation__ctor_" data-uid="SpiceSharp.Documentation.MemberDocumentation.#ctor*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation__ctor_System_Reflection_MemberInfo_" data-uid="SpiceSharp.Documentation.MemberDocumentation.#ctor(System.Reflection.MemberInfo)">MemberDocumentation(MemberInfo)</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="SpiceSharp.Documentation.MemberDocumentation.html">MemberDocumentation</a> class.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public MemberDocumentation(MemberInfo member)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.reflection.memberinfo">MemberInfo</a></td>
        <td><span class="parametername">member</span></td>
        <td><p>The member info.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
</h3>
  <a id="SpiceSharp_Documentation_MemberDocumentation_BaseType_" data-uid="SpiceSharp.Documentation.MemberDocumentation.BaseType*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_BaseType" data-uid="SpiceSharp.Documentation.MemberDocumentation.BaseType">BaseType</h4>
  <div class="markdown level1 summary"><p>Gets the base member type of the parameter and/or property.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Type BaseType { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></td>
        <td><p>The base type.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_Description_" data-uid="SpiceSharp.Documentation.MemberDocumentation.Description*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_Description" data-uid="SpiceSharp.Documentation.MemberDocumentation.Description">Description</h4>
  <div class="markdown level1 summary"><p>Gets the description of the property and/or parameter.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string Description { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
        <td><p>The description.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_Interesting_" data-uid="SpiceSharp.Documentation.MemberDocumentation.Interesting*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_Interesting" data-uid="SpiceSharp.Documentation.MemberDocumentation.Interesting">Interesting</h4>
  <div class="markdown level1 summary"><p>Gets a value indicating whether this member is interesting.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool Interesting { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
        <td><p><code>true</code> if this instance is interesting; otherwise, <code>false</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_IsParameter_" data-uid="SpiceSharp.Documentation.MemberDocumentation.IsParameter*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_IsParameter" data-uid="SpiceSharp.Documentation.MemberDocumentation.IsParameter">IsParameter</h4>
  <div class="markdown level1 summary"><p>Determines whether the member describes a parameter (can set a value).</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsParameter { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
        <td><p><code>true</code> if the member describes a parameter; otherwise, <code>false</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_IsPrincipal_" data-uid="SpiceSharp.Documentation.MemberDocumentation.IsPrincipal*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_IsPrincipal" data-uid="SpiceSharp.Documentation.MemberDocumentation.IsPrincipal">IsPrincipal</h4>
  <div class="markdown level1 summary"><p>Gets a value indicating whether this instance is principal.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsPrincipal { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
        <td><p><code>true</code> if this instance is principal; otherwise, <code>false</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_IsProperty_" data-uid="SpiceSharp.Documentation.MemberDocumentation.IsProperty*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_IsProperty" data-uid="SpiceSharp.Documentation.MemberDocumentation.IsProperty">IsProperty</h4>
  <div class="markdown level1 summary"><p>Determines whether the member describes a property (can return a value).</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsProperty { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
        <td><p><code>true</code> if the member describes a property; otherwise, <code>false</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_IsStatic_" data-uid="SpiceSharp.Documentation.MemberDocumentation.IsStatic*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_IsStatic" data-uid="SpiceSharp.Documentation.MemberDocumentation.IsStatic">IsStatic</h4>
  <div class="markdown level1 summary"><p>Gets a value indicating whether the member is static.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool IsStatic { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></td>
        <td><p><code>true</code> if this member is static; otherwise, <code>false</code>.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_Member_" data-uid="SpiceSharp.Documentation.MemberDocumentation.Member*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_Member" data-uid="SpiceSharp.Documentation.MemberDocumentation.Member">Member</h4>
  <div class="markdown level1 summary"><p>Gets the member.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public MemberInfo Member { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.reflection.memberinfo">MemberInfo</a></td>
        <td><p>The member.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_MemberType_" data-uid="SpiceSharp.Documentation.MemberDocumentation.MemberType*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_MemberType" data-uid="SpiceSharp.Documentation.MemberDocumentation.MemberType">MemberType</h4>
  <div class="markdown level1 summary"><p>Gets the type of the parameter and/or property.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Type MemberType { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.type">Type</a></td>
        <td><p>The type.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_Names_" data-uid="SpiceSharp.Documentation.MemberDocumentation.Names*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_Names" data-uid="SpiceSharp.Documentation.MemberDocumentation.Names">Names</h4>
  <div class="markdown level1 summary"><p>Gets the names of the member.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IReadOnlyList&lt;string&gt; Names { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.collections.generic.ireadonlylist-1">IReadOnlyList</a>&lt;<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a>&gt;</td>
        <td><p>The names of the member.</p>
</td>
      </tr>
    </tbody>
  </table>
  <a id="SpiceSharp_Documentation_MemberDocumentation_Units_" data-uid="SpiceSharp.Documentation.MemberDocumentation.Units*"></a>
  <h4 id="SpiceSharp_Documentation_MemberDocumentation_Units" data-uid="SpiceSharp.Documentation.MemberDocumentation.Units">Units</h4>
  <div class="markdown level1 summary"><p>Gets the units of the member.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="declaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string Units { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
        <td><p>The units.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="extensionmethods">Extension Methods</h3>
  <div>
      <a class="xref" href="SpiceSharp.Utility.html#SpiceSharp_Utility_ThrowIfNull__1___0_System_String_">Utility.ThrowIfNull&lt;T&gt;(T, string)</a>
  </div>

</article>
          </div>

          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In this article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>

      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
      
      <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>

    <script type="text/javascript" src="../styles/docfx.vendor.min.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
